collect: Return null from Spliterator.getComparator() for natural ordering#8174
Closed
nickita-khylkouski wants to merge 1 commit intogoogle:masterfrom
Closed
Conversation
…ering Per the Spliterator.getComparator() contract, return null to indicate natural ordering. This enables stream optimizations where sorted() becomes a no-op for already-sorted collections using natural ordering. Previously, ImmutableSortedSet and CollectSpliterators returned Ordering.natural() instead of null, which caused the JDK stream implementation to clear the SORTED flag and re-sort unnecessarily. The fix checks for both Ordering.natural() and Comparator.naturalOrder() using reference equality (both are singletons). Fixes google#6187
d90367a to
843e726
Compare
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
nullfromSpliterator.getComparator()when comparator is natural orderingOrdering.natural()andComparator.naturalOrder()(both singletons)ImmutableSortedSet.spliterator()andCollectSpliterators.indexed()Motivation
Per the Spliterator.getComparator() contract,
nullshould be returned to indicate natural ordering. The JDK stream implementation clears the SORTED flag whengetComparator()returns non-null, which prevents the sorted() optimization.This causes unnecessary sorting when calling
stream().sorted()on naturally-orderedImmutableSortedSet:Fixes #6187
Testing
Added 3 unit tests to
ImmutableSortedSetTest:testSpliteratorComparator_naturalOrdering- verifiesgetComparator()returns null for natural orderingtestSpliteratorComparator_customComparator- verifies custom comparator is returnedtestAsListSpliteratorComparator_naturalOrdering- verifiesasList().spliterator()also returns nullAlso verified locally that stream sorted() optimization now works correctly.